home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDITOR / CLASSW.ARJ / CLASSWRD.HLP < prev    next >
Text File  |  1992-01-19  |  10KB  |  276 lines
  1.  
  2.                  ClassWord Program Manual
  3.  
  4. ClassWord  is  a  word-square puzzle creator that hides a 
  5. list of words within a square of random letters.
  6.  
  7. ClassWord   randomly   places   the   words   vertically, 
  8. horizontally, diagonally, forward, and backward!
  9.  
  10. Once  created,  the  puzzle/solution  may  be reviewed on 
  11. screen and printed on your printer.
  12.  
  13. You  can  also  create and save as many word lists as you 
  14. wish to use again and again. 
  15.  
  16.                    Program Requirements
  17.  
  18.  
  19. ClassWord requires the following:
  20.  
  21.  
  22. *  Any IBM or compatible 
  23.  
  24.  
  25. *  => 256k RAM
  26.  
  27.  
  28. *  => DOS 2.0
  29.  
  30.  
  31.                      Program Features
  32.  
  33. A  context-sensitive  help  screen/scrollable  manual  is 
  34. always available by pressing the <F1> function key.
  35.  
  36. Use  of  a  color  or  monochrome screen is automatically 
  37. detected and the proper adjustments made.
  38.  
  39. The  intuitive  "point-and-shoot"  method  is the primary 
  40. means of user selection and input.
  41.  
  42. User  input  boxes are word processor capable, with arrow 
  43. cursoring, insert/overtype/delete functions, etc.
  44.  
  45.  
  46.                      The Main Screen
  47.  
  48. At  the  Main  Screen  you  can review the available word 
  49. lists.  From here, you can-
  50.  
  51. *  Select a word list for creating a puzzle      <ENTER>
  52.  
  53. *  Create and save a list of words                 <Ins>
  54.  
  55. *  Modify any word list on file                     <F5>
  56.  
  57. *  Delete any word list on file                    <Del>
  58.  
  59. *  Quit the Program                                <Esc>
  60.  
  61.                    Creating a Word List
  62.  
  63. You  may  enter from 1 to 20 words.  All words must be at 
  64. least  3  characters long and contain no spaces.  You may 
  65. also  enter an associated definition, although this entry 
  66. is  optional.   When  you  are finished entering the word 
  67. list, press the <F10> key.
  68.  
  69. Once  you  have finished entering your list of words, you 
  70. are  asked to specify a label to save the list by.  After 
  71. the  list of words is saved, you are returned to the Main 
  72. Screen  where you can then create a puzzle using any word 
  73. list  on  file  that  you  wish by highlighting that word 
  74. list and pressing the <ENTER> key.
  75.  
  76.                   Modifying a Word List
  77.  
  78.  
  79. If  you  highlight  a  word  list  in the Main Screen and 
  80. press  <F5>, you can then add, change, or delete any word 
  81. or definition in that word list as follows:
  82.  
  83.  
  84. *  Add a word to the list                          <Ins>
  85.  
  86. *  Change a word or a definition in the list        <F5>
  87.  
  88. *  Delete a word or a definition in the list       <Del>
  89.  
  90.  
  91.                    Deleting a Word List
  92.  
  93. A  word  list  can  be  deleted  from  the Main Screen by 
  94. highlighting the word list and pressing the <Del> Key.
  95.  
  96. The  program will beep twice and a message will appear at 
  97. the  bottom  of  the  screen displaying the word list you 
  98. want  to  delete  and  asking you to confirm your choice. 
  99. Here  you  must  press  either  the  letter  "y"  on  the 
  100. keyboard to confirm, or "n" to withdraw.
  101.  
  102. If  you  press  the "y" key, the word list is permanently 
  103. removed and may not be recovered.
  104.  
  105.  
  106.                    Creating the Puzzle
  107.  
  108. When  you  select a word list in the Main Screen, you are 
  109. asked  to  specify what size word square you wish to hide 
  110. the  list  of  words  in.   When  you enter a square size 
  111. choice,  the program will create the puzzle on the screen 
  112. in  real  time as you watch.  The smaller the square size 
  113. you  have  specified, the more difficult it is to fit the 
  114. list  of  words  within that square.  If you chose a very 
  115. small  square  size,  the  program  will  make  up  to 10 
  116. attempts  to  create  the  puzzle, at which point it will 
  117. offer  you  the  options  of trying once again, resetting 
  118. the  square  size,  or  simply giving up and returning to 
  119. the Main Screen.
  120.  
  121.              Displaying the Completed Puzzle
  122.  
  123. When  the  program  successfully places the list of words 
  124. within  the word square, you are presented with a display 
  125. of the puzzle on the screen.  At this point, you may:
  126.  
  127. *  View the puzzle/solution (toggle key)            <F3>
  128.  
  129. *  Print the puzzle on your printer                 <F5>
  130.  
  131. *  Redo  the  puzzle with the same set of words
  132.    if  you're  not  happy with the placement of
  133.    the words, or want to change the square size     <F8>
  134.  
  135.  
  136.                      Printing Options
  137.  
  138.  
  139. If  you choose to print the ClassWord puzzle, the program 
  140. will ask you to indicate:
  141.  
  142. *   whether  you  want the words or the definitions to be 
  143.     used  in  the  reference  list  printed on the puzzle 
  144.     page.
  145.  
  146. *   how many copies of the puzzle you want to print.
  147.  
  148. *   whether you wish to have a solution page printed, and 
  149.     if so, how many copies you want.
  150.  
  151.  
  152.  
  153.  
  154.                    Quitting the Program
  155.  
  156.  
  157. If  you  choose  this option at the Main Screen, you will 
  158. be asked to confirm.
  159.  
  160. Upon  entering  "y",  the  program  exits to DOS.  If you 
  161. entering  "n",  the  program  will resume the Main Screen 
  162. options.
  163.  
  164.  
  165.  
  166.                   Notes on Classroom Use
  167.  
  168. ClassWord  provides a very effective method of conducting 
  169. a  variety  of  educational  exercises  because  students 
  170. respond  positively  and attentively to the entertainment 
  171. and challenge of this type of learning tool.
  172.  
  173. Once  you start using ClassWord regularly, you will begin 
  174. to  appreciate  and  use the application flexibility that 
  175. lends   ClassWord  to  almost  any  type  of  associative 
  176. learning task.
  177.  
  178. The  key  to this flexibility is that each word in a list 
  179. can  be associated-- at your option-- with a "definition" 
  180. field,  and  you  decide  whether the reference list on a 
  181. printed  puzzle  is  to  be  the words themselves, or the 
  182. associated  definitions.   This allows you to design word 
  183. squares   in   a   variety  of  ways  according  to  your 
  184. particular educational goal.
  185.  
  186. This  opens  applications,  for  example,  for vocabulary 
  187. and  spelling  exercises  where the words are hidden in a 
  188. square  and  the  definitions comprise the reference list 
  189. on the puzzle page.
  190.  
  191. In  foreign language classes, word squares can be created 
  192. using  foreign words with English language "definitions", 
  193. or vice-versa.
  194.  
  195. In  geography  classes,  you  can  create a list of world 
  196. cities  with  the  appropriate  country  referenced  as a 
  197. definition, and so on...
  198.  
  199. As  you  can see by now, practical classroom applications 
  200. can  be  designed  with  ClassWord in any subject matter, 
  201. limited only by your creativity.
  202.  
  203.            Notes on ClassWord Program Design--
  204.  
  205. Programmers,   computer  students,  and  others  who  are 
  206. curious  about  the design of algorithms used in programs 
  207. like this may be interested in the following:
  208.  
  209. At  first  blush,  the  task  of  devising the algorithms 
  210. necessary  to  create a word-square puzzle seemed to be a 
  211. fairly  straightforward challenge with only a few logical 
  212. factors  to  consider.   I quickly found, however, that a 
  213. logical,  efficient  approach  resulted  in  the  program 
  214. being  too  eager  to  reject attempts to create a puzzle 
  215. with  diagonally  placed  words because of the difficulty 
  216. such  words  created  when  the  algorithm  tried to find 
  217. places  for the remaining unplaced words.  The result, of 
  218. course,  was  that almost all the words were being placed 
  219. in  either  vertical  or  horizontal  positions, which is 
  220. quickly  predictable  and too easily solved.  So I had to 
  221. devise  a compromising algorithm that would try harder to 
  222. place  diagonally  positioned  words  without creating an 
  223. unacceptable increase in processing time.
  224.  
  225. To  place  even  a  greater  burden  on  the algorithm, I 
  226. realized  that  it  was  also  important to encourage the 
  227. puzzle  creator  to  crisscross hidden words because that 
  228. makes  the  puzzles more interesting and creative.  While 
  229. the  coding  wasn't  as  difficult as I had first feared, 
  230. even  the  most optimized code resulted in an increase in 
  231. the  time  it  took  to  create  such a puzzle.  The real 
  232. challenge  wound  up  focusing more on finding acceptable 
  233. compromises  in  processing  time  than  on designing the 
  234. algorithms used.
  235.  
  236. Taking  all of these considerations into account resulted 
  237. in  a  program  that,  while it may not always create the 
  238. most  difficult  puzzle  possible,  it  usually creates a 
  239. challenging  puzzle  in  1 to 5 seconds (given moderately 
  240. challenging  parameters).   Even under the most difficult 
  241. circumstances  (many  long words of similar length, small 
  242. square  size),  it  will create a puzzle, if possible, in 
  243. less than a minute (depending on your computer's speed).
  244.  
  245. Even  10  seconds,  however,  can  be  a  long  time  for 
  246. computer  users  who  are  used  to  instant  results  in 
  247. standard  processing tasks.  The point of this discussion 
  248. for  those  interested  in programming is:  If you have a 
  249. processing  task  that  takes  more than a second or two, 
  250. display  something  on  the  screen  to  keep  the user's 
  251. attention.   When ClassWord is trying to create a puzzle, 
  252. for  instance, it displays the puzzle as it is being made 
  253. on  the  screen  in  real  time as ClassWord searches and 
  254. finds  places  to  put  the  words, thus keeping the user 
  255. informed  and  interested.   Remember that most people do 
  256. not  like to stare at an unchanging screen wondering what 
  257. is  a  program  doing and how long is it going to take to 
  258. do it.
  259.  
  260. The  point  of  this discussion for the non-programmer is 
  261. that  you will find that large puzzles are generally much 
  262. quicker  to  create, more imaginative because the program 
  263. has  more "breathing space" to be creative, and also more 
  264. challenging  simply because there are more characters for 
  265. someone  to search through-- on the other hand, it is fun 
  266. to  give  ClassWord  some  very  difficult parameters and 
  267. watch  it try to create an "impossible" puzzle.  Often it 
  268. will surprise you and do it! 
  269.  
  270.  
  271. ClassWord design            R. A. Delaroderie III
  272. ClassWord source code       Rad Delaroderie IV
  273.  
  274.  
  275.                 End of ClassWord Help File
  276.